package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.OnJobRecordAddDTO;
import org.jsola.hr.dto.OnJobRecordUpdateDTO;
import org.jsola.hr.query.OnJobRecordQuery;
import org.jsola.hr.vo.OnJobRecordListVO;
import org.jsola.hr.vo.OnJobRecordVO;

import java.util.List;

/**
 * 在职记录表
 *
 * @author zhr
 */
@Api(tags = "hr-在职记录表")
public interface IOnJobRecordControllerAPI {

    /**
     * 新增在职记录表
     * @param onJobRecordAddDTO 在职记录表新增实体
     * @return 在职记录表展示对象
     */
    @ApiOperation(value = "新增在职记录表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "onJobRecordAddDTO", dataType = "OnJobRecordAddDTO", value = "新增在职记录表", paramType = "body")
    })
    Result<OnJobRecordVO> save(OnJobRecordAddDTO onJobRecordAddDTO);


    /**
     * 修改在职记录表
     * @param onJobRecordUpdateDTO 在职记录表
     * @return 更新数量
     */
    @ApiOperation(value = "修改在职记录表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "onJobRecordUpdateDTO", dataType = "OnJobRecordUpdateDTO", value = "修改在职记录表", paramType = "body")
    })
    Result<Integer> update(OnJobRecordUpdateDTO onJobRecordUpdateDTO);




    /**
     * 删除单个在职记录表，彻底删除
     * @param onJobRecordId 在职记录表id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个在职记录表，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "onJobRecordId", dataType = "String", value = "在职记录表id", paramType = "path")
    })
    Result<Integer> delete(String onJobRecordId);


    /**
     * 批量删除在职记录表，彻底删除
     * @param onJobRecordIds 在职记录表id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除在职记录表，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "onJobRecordIds", dataType = "String[]", value = "在职记录表id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] onJobRecordIds);


    /**
     * 根据在职记录表id查询在职记录表详情
     * @param onJobRecordId 在职记录表id
     * @return 在职记录表详情
     */
    @ApiOperation(value="根据在职记录表id查询在职记录表详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "onJobRecordId", dataType = "String", value = "在职记录表id", paramType = "path")
    })
    Result<OnJobRecordVO> findById(String onJobRecordId);


    /**
     * 查询在职记录表
     * @param onJobRecordQuery 在职记录表查询参数
     * @return page
     */
    @ApiOperation(value="查询在职记录表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "onJobRecordQuery", dataType = "OnJobRecordQuery", value = "在职记录表查询参数", paramType = "query")
    })
    Result<List<OnJobRecordListVO>> listAll(OnJobRecordQuery onJobRecordQuery);


     /**
     * 分页查询在职记录表
     * @param onJobRecordQuery 在职记录表查询参数
     * @return page
     */
    @ApiOperation(value="分页查询在职记录表")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "onJobRecordQuery", dataType = "OnJobRecordQuery", value = "在职记录表查询参数", paramType = "query")
    })
    Result<Page<OnJobRecordListVO>> page(OnJobRecordQuery onJobRecordQuery);


}

